DOC: update the to_json() docstring #20149
Conversation
Fixes validation errors and adds an example for each orientation
There was a problem hiding this comment.
Thanks for the PR!
Added an inline comment. And two additional ones:
- In the See Also section, can you change
pd.read_jsontopandas.read_json? - In the "Parameters" section, in the description of the 'orient', in the bullet point "The format of the JSON string", can you quote the options? (so eg
- 'split': ...instead of- split: ...), to make it clear it are strings that needs to be passed.
pandas/core/generic.py
Outdated
| @@ -1665,8 +1665,9 @@ def to_json(self, path_or_buf=None, orient=None, date_format=None, | |||
| Parameters | |||
| ---------- | |||
| path_or_buf : the path or buffer to write the result string | |||
There was a problem hiding this comment.
The "the path or buffer to write the result string" is actually the explanation, so should go on the next line. On this line comes the type description, you can take a look at eg DataFrame.to_csv how this is typically explained.
There was a problem hiding this comment.
@jorisvandenbossche pandas.read_json also gives an error I'm afraid, but it is consistent with the other docstrings
pandas/core/generic.py
Outdated
| @@ -1665,8 +1665,9 @@ def to_json(self, path_or_buf=None, orient=None, date_format=None, | |||
| Parameters | |||
| ---------- | |||
| path_or_buf : the path or buffer to write the result string | |||
Adds quotes in parameters and updates path_or_buf to match to_csv
Codecov Report
@@ Coverage Diff @@
## master #20149 +/- ##
==========================================
+ Coverage 91.72% 91.76% +0.03%
==========================================
Files 150 150
Lines 49156 49148 -8
==========================================
+ Hits 45090 45099 +9
+ Misses 4066 4049 -17
Continue to review full report at Codecov.
|
|
@robmarkcole Thanks for the PR! |
Fixes validation errors and adds an example for each orientation.
scripts/validate_docstrings.py <your-function-or-method>git diff upstream/master -u -- "*.py" | flake8 --diffpython doc/make.py --single <your-function-or-method>I'm not able to make this pass.